+++ title = "Developer API" aliases = ["api"] date = "2019-05-31T09:01:00-00:00" type = "developer-api" draft = false weight = 8 +++
Documentation Powered by ReDoc

Kiali (_)

Download OpenAPI specification:Download

Kiali project, observability for the Istio service mesh

kiali

root

Endpoint to get the status of Kiali

Responses

200

HTTP status code 200 and statusInfo model in data

500

A Internal is the error message that means something has gone wrong

get/
/api/

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "externalServices":
    [
    ],
  • "status":
    {
    },
  • "warningMessages":
    [
    ]
}

getConfig

Endpoint to get the config of Kiali

Responses

200

HTTP status code 200 and statusInfo model in data

500

A Internal is the error message that means something has gone wrong

get/config
/api/config

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "externalServices":
    [
    ],
  • "status":
    {
    },
  • "warningMessages":
    [
    ]
}

healthz

Endpoint to get the health of Kiali

Responses

500

A Internal is the error message that means something has gone wrong

get/healthz
/api/healthz

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 500,
  • "message": "string"
}

auth

authenticationInfo

Endpoint to get login info, such as strategy, authorization endpoints for OAuth providers and so on.

Responses

200

Return the information necessary to handle login

500

A Internal is the error message that means something has gone wrong

get/auth/info
/api/auth/info

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 500,
  • "message": "string"
}

authenticate

Endpoint to authenticate the user

Authorizations:

Responses

200

HTTP status code 200 and tokenGenerated model in data

500

A Internal is the error message that means something has gone wrong

get/authenticate
/api/authenticate

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "expiresOn": "Thu, 07 Mar 2019 17:50:26 +0000",
  • "token": "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD",
  • "username": "admin"
}

openshiftCheckToken

Endpoint to check if a token from Openshift is working correctly

Responses

200

HTTP status code 200 and tokenGenerated model in data

500

A Internal is the error message that means something has gone wrong

post/authenticate
/api/authenticate

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "expiresOn": "Thu, 07 Mar 2019 17:50:26 +0000",
  • "token": "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD",
  • "username": "admin"
}

logout

Endpoint to logout an user (unset the session cookie)

Responses

204

NoContent: the response is empty

get/logout
/api/logout

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 204,
  • "message": "string"
}

integrations

grafanaInfo

Get the grafana URL and other descriptors

Responses

200

Return all the descriptor data related to Grafana

204

NoContent: the response is empty

500

A Internal is the error message that means something has gone wrong

503

A Internal is the error message that means something has gone wrong

get/grafana
/api/grafana

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "externalLinks":
    [
    ]
}

jaegerInfo

Get the jaeger URL and other descriptors

Responses

200

Return all the descriptor data related to Jaeger

404

A NotFoundError is the error message that is generated when server could not find what was requested.

406

A NotAcceptable is the error message that means request can't be accepted

get/jaeger
/api/jaeger

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "integration": true,
  • "namespaceSelector": true,
  • "url": "string",
  • "whiteListIstioSystem":
    [
    ]
}

config

getPermissions

Endpoint to get the caller permissions on new Istio Config objects

Responses

200

Return caller permissions per namespace and Istio Config type

500

A Internal is the error message that means something has gone wrong

get/istio/permissions
/api/istio/permissions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

istioConfigList

Endpoint to get the list of Istio Config of a namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

HTTP status code 200 and IstioConfigList model in data

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/istio
/api/namespaces/{namespace}/istio

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapters":
    [
    ],
  • "authorizationPolicies":
    [
    ],
  • "clusterRbacConfigs":
    [
    ],
  • "destinationRules":
    {
    },
  • "gateways":
    [
    ],
  • "meshPolicies":
    [
    ],
  • "namespace":
    {
    },
  • "peerAuthentications":
    [
    ],
  • "policies":
    [
    ],
  • "quotaSpecBindings":
    [
    ],
  • "quotaSpecs":
    [
    ],
  • "rbacConfigs":
    [
    ],
  • "requestAuthentications":
    [
    ],
  • "rules":
    [
    ],
  • "serviceEntries":
    [
    ],
  • "serviceMeshPolicies":
    [
    ],
  • "serviceMeshRbacConfigs":
    [
    ],
  • "serviceRoleBindings":
    [
    ],
  • "serviceRoles":
    [
    ],
  • "sidecars":
    [
    ],
  • "templates":
    [
    ],
  • "validations": null,
  • "virtualServices":
    {
    },
  • "workloadEntries":
    [
    ]
}

istioConfigCreate

Endpoint to create an Istio object by using an Istio Config item

path Parameters
namespace
required
string

The namespace name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

Responses

200

IstioConfig details of an specific Istio Object

201

IstioConfig details of an specific Istio Object

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

post/namespaces/{namespace}/istio/{object_type}
/api/namespaces/{namespace}/istio/{object_type}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapter":
    {
    },
  • "authorizationPolicy":
    {
    },
  • "clusterRbacConfig":
    {
    },
  • "destinationRule":
    {
    },
  • "gateway":
    {
    },
  • "meshPolicy":
    {
    },
  • "namespace":
    {
    },
  • "objectType": "string",
  • "peerAuthentication":
    {
    },
  • "permissions":
    {
    },
  • "policy":
    {
    },
  • "quotaSpec":
    {
    },
  • "quotaSpecBinding":
    {
    },
  • "rbacConfig":
    {
    },
  • "requestAuthentication":
    {
    },
  • "rule":
    {
    },
  • "serviceEntry":
    {
    },
  • "serviceMeshPolicy":
    {
    },
  • "serviceMeshRbacConfig":
    {
    },
  • "serviceRole":
    {
    },
  • "serviceRoleBinding":
    {
    },
  • "sidecar":
    {
    },
  • "template":
    {
    },
  • "validation":
    {
    },
  • "virtualService":
    {
    },
  • "workloadEntry":
    {
    }
}

istioConfigCreateSubtype

Endpoint to create an Istio object by using an Istio Config item

path Parameters
namespace
required
string

The namespace name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

object_subtype
required
string

The Istio object subtype.

Responses

200

IstioConfig details of an specific Istio Object

201

IstioConfig details of an specific Istio Object

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

post/namespaces/{namespace}/istio/{object_type}/{object_subtype}
/api/namespaces/{namespace}/istio/{object_type}/{object_subtype}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapter":
    {
    },
  • "authorizationPolicy":
    {
    },
  • "clusterRbacConfig":
    {
    },
  • "destinationRule":
    {
    },
  • "gateway":
    {
    },
  • "meshPolicy":
    {
    },
  • "namespace":
    {
    },
  • "objectType": "string",
  • "peerAuthentication":
    {
    },
  • "permissions":
    {
    },
  • "policy":
    {
    },
  • "quotaSpec":
    {
    },
  • "quotaSpecBinding":
    {
    },
  • "rbacConfig":
    {
    },
  • "requestAuthentication":
    {
    },
  • "rule":
    {
    },
  • "serviceEntry":
    {
    },
  • "serviceMeshPolicy":
    {
    },
  • "serviceMeshRbacConfig":
    {
    },
  • "serviceRole":
    {
    },
  • "serviceRoleBinding":
    {
    },
  • "sidecar":
    {
    },
  • "template":
    {
    },
  • "validation":
    {
    },
  • "virtualService":
    {
    },
  • "workloadEntry":
    {
    }
}

istioConfigDetailsSubtype

Endpoint to get the Istio Config of an Istio object used for templates and adapters that is necessary to define a subtype

path Parameters
namespace
required
string

The namespace name.

object
required
string

The Istio object name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

object_subtype
required
string

The Istio object subtype.

Responses

200

IstioConfig details of an specific Istio Object

400

BadRequestError: the client request is incorrect

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/istio/{object_type}/{object_subtype}/{object}
/api/namespaces/{namespace}/istio/{object_type}/{object_subtype}/{object}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapter":
    {
    },
  • "authorizationPolicy":
    {
    },
  • "clusterRbacConfig":
    {
    },
  • "destinationRule":
    {
    },
  • "gateway":
    {
    },
  • "meshPolicy":
    {
    },
  • "namespace":
    {
    },
  • "objectType": "string",
  • "peerAuthentication":
    {
    },
  • "permissions":
    {
    },
  • "policy":
    {
    },
  • "quotaSpec":
    {
    },
  • "quotaSpecBinding":
    {
    },
  • "rbacConfig":
    {
    },
  • "requestAuthentication":
    {
    },
  • "rule":
    {
    },
  • "serviceEntry":
    {
    },
  • "serviceMeshPolicy":
    {
    },
  • "serviceMeshRbacConfig":
    {
    },
  • "serviceRole":
    {
    },
  • "serviceRoleBinding":
    {
    },
  • "sidecar":
    {
    },
  • "template":
    {
    },
  • "validation":
    {
    },
  • "virtualService":
    {
    },
  • "workloadEntry":
    {
    }
}

istioConfigDeleteSubtype

Endpoint to delete the Istio Config of an Istio object used for templates and adapters

path Parameters
namespace
required
string

The namespace name.

object
required
string

The Istio object name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

object_subtype
required
string

The Istio object subtype.

Responses

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

delete/namespaces/{namespace}/istio/{object_type}/{object_subtype}/{object}
/api/namespaces/{namespace}/istio/{object_type}/{object_subtype}/{object}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 404,
  • "message": "string"
}

Endpoint to update the Istio Config of an Istio object used for templates and adapters using Json Merge Patch strategy.

path Parameters
namespace
required
string

The namespace name.

object
required
string

The Istio object name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

object_subtype
required
string

The Istio object subtype.

Responses

200

IstioConfig details of an specific Istio Object

400

BadRequestError: the client request is incorrect

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

patch/namespaces/{namespace}/istio/{object_type}/{object_subtype}/{object}
/api/namespaces/{namespace}/istio/{object_type}/{object_subtype}/{object}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapter":
    {
    },
  • "authorizationPolicy":
    {
    },
  • "clusterRbacConfig":
    {
    },
  • "destinationRule":
    {
    },
  • "gateway":
    {
    },
  • "meshPolicy":
    {
    },
  • "namespace":
    {
    },
  • "objectType": "string",
  • "peerAuthentication":
    {
    },
  • "permissions":
    {
    },
  • "policy":
    {
    },
  • "quotaSpec":
    {
    },
  • "quotaSpecBinding":
    {
    },
  • "rbacConfig":
    {
    },
  • "requestAuthentication":
    {
    },
  • "rule":
    {
    },
  • "serviceEntry":
    {
    },
  • "serviceMeshPolicy":
    {
    },
  • "serviceMeshRbacConfig":
    {
    },
  • "serviceRole":
    {
    },
  • "serviceRoleBinding":
    {
    },
  • "sidecar":
    {
    },
  • "template":
    {
    },
  • "validation":
    {
    },
  • "virtualService":
    {
    },
  • "workloadEntry":
    {
    }
}

istioConfigDetails

Endpoint to get the Istio Config of an Istio object

path Parameters
namespace
required
string

The namespace name.

object
required
string

The Istio object name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

Responses

200

IstioConfig details of an specific Istio Object

400

BadRequestError: the client request is incorrect

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/istio/{object_type}/{object}
/api/namespaces/{namespace}/istio/{object_type}/{object}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapter":
    {
    },
  • "authorizationPolicy":
    {
    },
  • "clusterRbacConfig":
    {
    },
  • "destinationRule":
    {
    },
  • "gateway":
    {
    },
  • "meshPolicy":
    {
    },
  • "namespace":
    {
    },
  • "objectType": "string",
  • "peerAuthentication":
    {
    },
  • "permissions":
    {
    },
  • "policy":
    {
    },
  • "quotaSpec":
    {
    },
  • "quotaSpecBinding":
    {
    },
  • "rbacConfig":
    {
    },
  • "requestAuthentication":
    {
    },
  • "rule":
    {
    },
  • "serviceEntry":
    {
    },
  • "serviceMeshPolicy":
    {
    },
  • "serviceMeshRbacConfig":
    {
    },
  • "serviceRole":
    {
    },
  • "serviceRoleBinding":
    {
    },
  • "sidecar":
    {
    },
  • "template":
    {
    },
  • "validation":
    {
    },
  • "virtualService":
    {
    },
  • "workloadEntry":
    {
    }
}

istioConfigDelete

Endpoint to delete the Istio Config of an (arbitrary) Istio object

path Parameters
namespace
required
string

The namespace name.

object
required
string

The Istio object name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

Responses

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

delete/namespaces/{namespace}/istio/{object_type}/{object}
/api/namespaces/{namespace}/istio/{object_type}/{object}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 404,
  • "message": "string"
}

Endpoint to update the Istio Config of an Istio object used for templates and adapters using Json Merge Patch strategy.

path Parameters
namespace
required
string

The namespace name.

object
required
string

The Istio object name.

object_type
required
string ^(gateways|virtualservices|destinationrules|serviceentries|rules|quotaspecs|quotaspecbindings)$

The Istio object type.

Responses

200

IstioConfig details of an specific Istio Object

400

BadRequestError: the client request is incorrect

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

patch/namespaces/{namespace}/istio/{object_type}/{object}
/api/namespaces/{namespace}/istio/{object_type}/{object}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adapter":
    {
    },
  • "authorizationPolicy":
    {
    },
  • "clusterRbacConfig":
    {
    },
  • "destinationRule":
    {
    },
  • "gateway":
    {
    },
  • "meshPolicy":
    {
    },
  • "namespace":
    {
    },
  • "objectType": "string",
  • "peerAuthentication":
    {
    },
  • "permissions":
    {
    },
  • "policy":
    {
    },
  • "quotaSpec":
    {
    },
  • "quotaSpecBinding":
    {
    },
  • "rbacConfig":
    {
    },
  • "requestAuthentication":
    {
    },
  • "rule":
    {
    },
  • "serviceEntry":
    {
    },
  • "serviceMeshPolicy":
    {
    },
  • "serviceMeshRbacConfig":
    {
    },
  • "serviceRole":
    {
    },
  • "serviceRoleBinding":
    {
    },
  • "sidecar":
    {
    },
  • "template":
    {
    },
  • "validation":
    {
    },
  • "virtualService":
    {
    },
  • "workloadEntry":
    {
    }
}

status

istioStatus

Get the status of each components needed in the control plane

Responses

200

Return a list of Istio components along its status

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/istio/status
/api/istio/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

getStatus

Endpoint to get the status of Kiali

Responses

200

HTTP status code 200 and statusInfo model in data

500

A Internal is the error message that means something has gone wrong

get/status
/api/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "externalServices":
    [
    ],
  • "status":
    {
    },
  • "warningMessages":
    [
    ]
}

iter8

Endpoint to fetch iter8 experiments for all namespaces user have access.

User can define a comman separated list of namespaces.

Responses

200

Return a list of Iter8 Experiment Items

500

A Internal is the error message that means something has gone wrong

get/iter8/experiments
/api/iter8/experiments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

deleteIter8Experiments

Endpoint to delete iter8 experiments

path Parameters
namespace
required
string

The namespace name.

name
required
string

The name param

Responses

500

A Internal is the error message that means something has gone wrong

delete/iter8/experiments/namespaces/{namespace}/name/{name}
/api/iter8/experiments/namespaces/{namespace}/name/{name}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 500,
  • "message": "string"
}

patchIter8Experiments

Endpoint to update new iter8 experiment (for abort purpose)

path Parameters
namespace
required
string

The namespace name.

name
required
string

The name param

Responses

200

Return a Iter8 Experiment detail

500

A Internal is the error message that means something has gone wrong

patch/iter8/experiments/{namespace}/name/{name}
/api/iter8/experiments/{namespace}/name/{name}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "criterias":
    [
    ],
  • "experimentItem":
    {
    },
  • "permissions":
    {
    },
  • "trafficControl":
    {
    }
}

Endpoint to create new iter8 experiments for a given namespace.

path Parameters
namespace
required
string

The namespace name.

Responses

200

Return a Iter8 Experiment detail

500

A Internal is the error message that means something has gone wrong

post/iter8/namespaces/{namespace}/experiments
/api/iter8/namespaces/{namespace}/experiments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "criterias":
    [
    ],
  • "experimentItem":
    {
    },
  • "permissions":
    {
    },
  • "trafficControl":
    {
    }
}

getIter8Experiments

Endpoint to fetch iter8 experiments by namespace and name

path Parameters
namespace
required
string

The namespace name.

name
required
string

The name param

Responses

200

Return a Iter8 Experiment detail

500

A Internal is the error message that means something has gone wrong

get/iter8/namespaces/{namespace}/experiments/{name}
/api/iter8/namespaces/{namespace}/experiments/{name}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "criterias":
    [
    ],
  • "experimentItem":
    {
    },
  • "permissions":
    {
    },
  • "trafficControl":
    {
    }
}

tls

meshTls

Get TLS status for the whole mesh

Responses

200

Return the mTLS status of the whole Mesh

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/mesh/tls
/api/mesh/tls

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "MTLS_ENABLED"
}

namespaceTls

Get TLS status for the given namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

Return the mTLS status of a specific Namespace

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/tls
/api/namespaces/{namespace}/tls

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "MTLS_ENABLED"
}

namespaces

namespaceList

Endpoint to get the list of the available namespaces

Responses

200

List of Namespaces

500

A Internal is the error message that means something has gone wrong

get/namespaces
/api/namespaces

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

namespaceHealth

Get health for all objects in the given namespace

path Parameters
namespace
required
string

The namespace scope

query Parameters
rateInterval
string
Default: "10m"

The rate interval used for fetching error rate

QueryTime
string <date-time>

The time to use for the prometheus query

type
string ^(app|service|workload)$
Default: "app"

The type of health, "app", "service" or "workload".

Responses

200

namespaceAppHealthResponse is a map of app name x health

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/health
/api/namespaces/{namespace}/health

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

namespaceMetrics

Endpoint to fetch metrics to be displayed, related to a namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

Metrics response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/metrics
/api/namespaces/{namespace}/metrics

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "histograms":
    {
    },
  • "metrics":
    {
    }
}

namespaceValidations

Get validation summary for all objects in the given namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

Return the validation status of a specific Namespace

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/validations
/api/namespaces/{namespace}/validations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errors": 2,
  • "objectCount": 6,
  • "warnings": 4
}

graphs

The backing JSON for a namespaces graph.

query Parameters
appenders
string
Default: "run all appenders"

Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode].

duration
string
Default: "10m"

Query time-range duration (Golang string duration).

graphType
string
Default: "workload"

Graph type. Available graph types: [app, service, versionedApp, workload].

groupBy
string
Default: "none"

App box grouping characteristic. Available groupings: [app, none, version].

injectServiceNodes
string
Default: "false"

Flag for injecting the requested service node between source and destination nodes.

namespaces
required
string

Comma-separated list of namespaces to include in the graph. The namespaces must be accessible to the client.

queryTime
string
Default: "now"

Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now.

Responses

200

HTTP status code 200 and cytoscapejs Config in data

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/graph
/api/namespaces/graph

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "duration": 0,
  • "elements":
    {
    },
  • "graphType": "string",
  • "timestamp": 0
}

graphApp

The backing JSON for an app node detail graph. (supported graphTypes: app | versionedApp)

path Parameters
app
required
string

The app name (label value).

namespace
required
string

The namespace name.

query Parameters
appenders
string
Default: "run all appenders"

Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode].

duration
string
Default: "10m"

Query time-range duration (Golang string duration).

graphType
string
Default: "workload"

Graph type. Available graph types: [app, service, versionedApp, workload].

groupBy
string
Default: "none"

App box grouping characteristic. Available groupings: [app, none, version].

injectServiceNodes
string
Default: "false"

Flag for injecting the requested service node between source and destination nodes.

queryTime
string
Default: "now"

Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now.

Responses

200

HTTP status code 200 and cytoscapejs Config in data

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/applications/{app}/graph
/api/namespaces/{namespace}/applications/{app}/graph

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "duration": 0,
  • "elements":
    {
    },
  • "graphType": "string",
  • "timestamp": 0
}

graphAppVersion

The backing JSON for a versioned app node detail graph. (supported graphTypes: app | versionedApp)

path Parameters
app
required
string

The app name (label value).

version
required
string

The app version (label value).

namespace
required
string

The namespace name.

query Parameters
appenders
string
Default: "run all appenders"

Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode].

duration
string
Default: "10m"

Query time-range duration (Golang string duration).

graphType
string
Default: "workload"

Graph type. Available graph types: [app, service, versionedApp, workload].

groupBy
string
Default: "none"

App box grouping characteristic. Available groupings: [app, none, version].

injectServiceNodes
string
Default: "false"

Flag for injecting the requested service node between source and destination nodes.

queryTime
string
Default: "now"

Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now.

Responses

200

HTTP status code 200 and cytoscapejs Config in data

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/applications/{app}/versions/{version}/graph
/api/namespaces/{namespace}/applications/{app}/versions/{version}/graph

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "duration": 0,
  • "elements":
    {
    },
  • "graphType": "string",
  • "timestamp": 0
}

The backing JSON for a service node detail graph.

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

query Parameters
appenders
string
Default: "run all appenders"

Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode].

duration
string
Default: "10m"

Query time-range duration (Golang string duration).

graphType
string
Default: "workload"

Graph type. Available graph types: [app, service, versionedApp, workload].

groupBy
string
Default: "none"

App box grouping characteristic. Available groupings: [app, none, version].

queryTime
string
Default: "now"

Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now.

Responses

200

HTTP status code 200 and cytoscapejs Config in data

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/graph
/api/namespaces/{namespace}/services/{service}/graph

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "duration": 0,
  • "elements":
    {
    },
  • "graphType": "string",
  • "timestamp": 0
}

The backing JSON for a workload node detail graph.

path Parameters
namespace
required
string

The namespace name.

workload
required
string

The workload name.

query Parameters
appenders
string
Default: "run all appenders"

Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode].

duration
string
Default: "10m"

Query time-range duration (Golang string duration).

graphType
string
Default: "workload"

Graph type. Available graph types: [app, service, versionedApp, workload].

groupBy
string
Default: "none"

App box grouping characteristic. Available groupings: [app, none, version].

injectServiceNodes
string
Default: "false"

Flag for injecting the requested service node between source and destination nodes.

queryTime
string
Default: "now"

Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now.

Responses

200

HTTP status code 200 and cytoscapejs Config in data

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/workloads/{workload}/graph
/api/namespaces/{namespace}/workloads/{workload}/graph

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "duration": 0,
  • "elements":
    {
    },
  • "graphType": "string",
  • "timestamp": 0
}

apps

appList

Endpoint to get the list of apps for a namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

Listing all apps in the namespace

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/apps
/api/namespaces/{namespace}/apps

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "applications":
    [
    ],
  • "namespace":
    {
    }
}

appDetails

Endpoint to get the app details

path Parameters
app
required
string

The app name (label value).

namespace
required
string

The namespace name.

Responses

200

Detailed information of an specific app

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/apps/{app}
/api/namespaces/{namespace}/apps/{app}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "reviews",
  • "namespace":
    {
    },
  • "runtimes":
    [
    ],
  • "serviceNames":
    [
    ],
  • "workloads":
    [
    ]
}

appDashboard

Endpoint to fetch dashboard to be displayed, related to a single app

path Parameters
app
required
string

The app name (label value).

namespace
required
string

The namespace name.

query Parameters
avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

direction
string
Default: "outbound"

Traffic direction: 'inbound' or 'outbound'.

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

requestProtocol
string
Default: "all protocols"

Desired request protocol for the telemetry: For example, 'http' or 'grpc'.

reporter
string
Default: "source"

Istio telemetry reporter: 'source' or 'destination'.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

Responses

200

Dashboard response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/apps/{app}/dashboard
/api/namespaces/{namespace}/apps/{app}/dashboard

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aggregations":
    [
    ],
  • "charts":
    [
    ],
  • "externalLinks":
    [
    ],
  • "title": "string"
}

appHealth

Get health associated to the given app

path Parameters
namespace
required
string

The namespace scope

app
required
string

The target app

query Parameters
rateInterval
string
Default: "10m"

The rate interval used for fetching error rate

QueryTime
string <date-time>

The time to use for the prometheus query

Responses

200

appHealthResponse contains aggregated health from various sources, for a given app

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/apps/{app}/health
/api/namespaces/{namespace}/apps/{app}/health

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    {
    },
  • "workloadStatuses":
    [
    ]
}

appMetrics

Endpoint to fetch metrics to be displayed, related to a single app

path Parameters
app
required
string

The app name (label value).

namespace
required
string

The namespace name.

query Parameters
avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

direction
string
Default: "outbound"

Traffic direction: 'inbound' or 'outbound'.

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

filters[]
Array of strings
Default: []

List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names.

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

requestProtocol
string
Default: "all protocols"

Desired request protocol for the telemetry: For example, 'http' or 'grpc'.

reporter
string
Default: "source"

Istio telemetry reporter: 'source' or 'destination'.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

version
string

Filters metrics by the specified version.

Responses

200

Metrics response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/apps/{app}/metrics
/api/namespaces/{namespace}/apps/{app}/metrics

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "histograms":
    {
    },
  • "metrics":
    {
    }
}

dashboards

customDashboard

Endpoint to fetch a custom dashboard

path Parameters
namespace
required
string

The namespace name.

dashboard
required
string

The dashboard resource name.

query Parameters
additionalLabels
string

In custom dashboards, additional labels that are made available for grouping in the UI, regardless which aggregations are defined in the MonitoringDashboard CR

avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

labelsFilters
string

In custom dashboards, labels filters to use when fetching metrics, formatted as key:value pairs. Ex: "app:foo,version:bar".

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

Responses

200

Dashboard response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/customdashboard/{dashboard}
/api/namespaces/{namespace}/customdashboard/{dashboard}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aggregations":
    [
    ],
  • "charts":
    [
    ],
  • "externalLinks":
    [
    ],
  • "title": "string"
}

pods

podDetails

Endpoint to get pod details

path Parameters
namespace
required
string

The namespace name.

pod
required
string

The pod name.

Responses

200

Listing all the information related to a workload

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/pods/{pod}
/api/namespaces/{namespace}/pods/{pod}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "additionalDetailSample":
    {
    },
  • "additionalDetails":
    [
    ],
  • "appLabel": true,
  • "availableReplicas": 1,
  • "createdAt": "2018-07-31T12:24:17Z",
  • "currentReplicas": 2,
  • "desiredReplicas": 2,
  • "istioSidecar": true,
  • "labels":
    {
    },
  • "name": "reviews-v1",
  • "podCount": 1,
  • "pods":
    [
    ],
  • "resourceVersion": "192892127",
  • "runtimes":
    [
    ],
  • "services":
    [
    ],
  • "type": "deployment",
  • "versionLabel": true
}

podLogs

Endpoint to get pod logs

path Parameters
namespace
required
string

The namespace name.

pod
required
string

The pod name.

query Parameters
container
string

The pod container name. Optional for single-container pod. Otherwise required.

sinceTime
string

The start time for fetching logs. UNIX time in seconds. Default is all logs.

Responses

200

Listing all the information related to a workload

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/pods/{pod}/logs
/api/namespaces/{namespace}/pods/{pod}/logs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "additionalDetailSample":
    {
    },
  • "additionalDetails":
    [
    ],
  • "appLabel": true,
  • "availableReplicas": 1,
  • "createdAt": "2018-07-31T12:24:17Z",
  • "currentReplicas": 2,
  • "desiredReplicas": 2,
  • "istioSidecar": true,
  • "labels":
    {
    },
  • "name": "reviews-v1",
  • "podCount": 1,
  • "pods":
    [
    ],
  • "resourceVersion": "192892127",
  • "runtimes":
    [
    ],
  • "services":
    [
    ],
  • "type": "deployment",
  • "versionLabel": true
}

services

serviceList

Endpoint to get the details of a given service

path Parameters
namespace
required
string

The namespace name.

Responses

200

Listing all services in the namespace

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services
/api/namespaces/{namespace}/services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "namespace":
    {
    },
  • "services":
    [
    ],
  • "validations": null
}

serviceDetails

Endpoint to get the details of a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Listing all the information related to a workload

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}
/api/namespaces/{namespace}/services/{service}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "additionalDetails":
    [
    ],
  • "destinationRules":
    {
    },
  • "endpoints":
    [
    ],
  • "health":
    {
    },
  • "istioSidecar": true,
  • "namespaceMTLS":
    {
    },
  • "service":
    {
    },
  • "validations": null,
  • "virtualServices":
    {
    },
  • "workloads":
    [
    ]
}

serviceDashboard

Endpoint to fetch dashboard to be displayed, related to a single service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

query Parameters
avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

direction
string
Default: "outbound"

Traffic direction: 'inbound' or 'outbound'.

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

requestProtocol
string
Default: "all protocols"

Desired request protocol for the telemetry: For example, 'http' or 'grpc'.

reporter
string
Default: "source"

Istio telemetry reporter: 'source' or 'destination'.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

Responses

200

Dashboard response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/dashboard
/api/namespaces/{namespace}/services/{service}/dashboard

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aggregations":
    [
    ],
  • "charts":
    [
    ],
  • "externalLinks":
    [
    ],
  • "title": "string"
}

serviceHealth

Get health associated to the given service

path Parameters
namespace
required
string

The namespace scope

service
required
string

The target service

query Parameters
rateInterval
string
Default: "10m"

The rate interval used for fetching error rate

QueryTime
string <date-time>

The time to use for the prometheus query

Responses

200

serviceHealthResponse contains aggregated health from various sources, for a given service

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/health
/api/namespaces/{namespace}/services/{service}/health

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    {
    }
}

serviceMetrics

Endpoint to fetch metrics to be displayed, related to a single service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

query Parameters
avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

direction
string
Default: "outbound"

Traffic direction: 'inbound' or 'outbound'.

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

filters[]
Array of strings
Default: []

List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names.

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

requestProtocol
string
Default: "all protocols"

Desired request protocol for the telemetry: For example, 'http' or 'grpc'.

reporter
string
Default: "source"

Istio telemetry reporter: 'source' or 'destination'.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

version
string

Filters metrics by the specified version.

Responses

200

Metrics response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/metrics
/api/namespaces/{namespace}/services/{service}/metrics

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "histograms":
    {
    },
  • "metrics":
    {
    }
}

traces

errorTraces

Endpoint to get the number of traces in error for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Number of traces in error

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/errortraces
/api/namespaces/{namespace}/services/{service}/errortraces

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 404,
  • "message": "string"
}

spansList

Endpoint to get Jaeger spans for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Listing all the information related to a Span

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/spans
/api/namespaces/{namespace}/services/{service}/spans

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

tracesDetail

Endpoint to get a specific trace of a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Listing all the information related to a Trace

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/services/{service}/traces
/api/namespaces/{namespace}/services/{service}/traces

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

workloads

workloadList

Endpoint to get the list of workloads for a namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

Listing all workloads in the namespace

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/workloads
/api/namespaces/{namespace}/workloads

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "namespace":
    {
    },
  • "workloads":
    [
    ]
}

workloadDetails

Endpoint to get the workload details

path Parameters
namespace
required
string

The namespace name.

workload
required
string

The workload name.

Responses

200

Listing all the information related to a workload

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/workloads/{workload}
/api/namespaces/{namespace}/workloads/{workload}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "additionalDetailSample":
    {
    },
  • "additionalDetails":
    [
    ],
  • "appLabel": true,
  • "availableReplicas": 1,
  • "createdAt": "2018-07-31T12:24:17Z",
  • "currentReplicas": 2,
  • "desiredReplicas": 2,
  • "istioSidecar": true,
  • "labels":
    {
    },
  • "name": "reviews-v1",
  • "podCount": 1,
  • "pods":
    [
    ],
  • "resourceVersion": "192892127",
  • "runtimes":
    [
    ],
  • "services":
    [
    ],
  • "type": "deployment",
  • "versionLabel": true
}

workloadDashboard

Endpoint to fetch dashboard to be displayed, related to a single workload

path Parameters
namespace
required
string

The namespace name.

workload
required
string

The workload name.

query Parameters
avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

direction
string
Default: "outbound"

Traffic direction: 'inbound' or 'outbound'.

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

requestProtocol
string
Default: "all protocols"

Desired request protocol for the telemetry: For example, 'http' or 'grpc'.

reporter
string
Default: "source"

Istio telemetry reporter: 'source' or 'destination'.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

Responses

200

Dashboard response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/workloads/{workload}/dashboard
/api/namespaces/{namespace}/workloads/{workload}/dashboard

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aggregations":
    [
    ],
  • "charts":
    [
    ],
  • "externalLinks":
    [
    ],
  • "title": "string"
}

workloadHealth

Get health associated to the given workload

path Parameters
namespace
required
string

The namespace scope

workload
required
string

The target workload

query Parameters
rateInterval
string
Default: "10m"

The rate interval used for fetching error rate

QueryTime
string <date-time>

The time to use for the prometheus query

Responses

200

workloadHealthResponse contains aggregated health from various sources, for a given workload

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/workloads/{workload}/health
/api/namespaces/{namespace}/workloads/{workload}/health

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    {
    },
  • "workloadStatus":
    {
    }
}

workloadMetrics

Endpoint to fetch metrics to be displayed, related to a single workload

path Parameters
namespace
required
string

The namespace name.

workload
required
string

The workload name.

query Parameters
avg
boolean
Default: true

Flag for fetching histogram average. Default is true.

byLabels[]
Array of strings
Default: []

List of labels to use for grouping metrics (via Prometheus 'by' clause).

direction
string
Default: "outbound"

Traffic direction: 'inbound' or 'outbound'.

duration
integer <int64>
Default: 1800

Duration of the query period, in seconds.

filters[]
Array of strings
Default: []

List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names.

quantiles[]
Array of strings
Default: []

List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99].

rateFunc
string
Default: "rate"

Prometheus function used to calculate rate: 'rate' or 'irate'.

rateInterval
string
Default: "1m"

Interval used for rate and histogram calculation.

requestProtocol
string
Default: "all protocols"

Desired request protocol for the telemetry: For example, 'http' or 'grpc'.

reporter
string
Default: "source"

Istio telemetry reporter: 'source' or 'destination'.

step
integer <int64>
Default: 15

Step between [graph] datapoints, in seconds.

version
string

Filters metrics by the specified version.

Responses

200

Metrics response model

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get/namespaces/{namespace}/workloads/{workload}/metrics
/api/namespaces/{namespace}/workloads/{workload}/metrics

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "histograms":
    {
    },
  • "metrics":
    {
    }
}

threescale

getThreeScaleInfo

Endpoint to check if threescale adapter is present in the cluster and if user can write adapter config

Responses

200

Return if ThreeScale adapter is enabled in Istio and if user has permissions to write adapter's configuration

500

A Internal is the error message that means something has gone wrong

get/threescale
/api/threescale

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "permissions":
    {
    }
}

getThreeScaleHandlers

Endpoint to fetch threescale handlers generated from Kiali

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

500

A Internal is the error message that means something has gone wrong

get/threescale/handlers
/api/threescale/handlers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

postThreeScaleHandlers

Endpoint to create a new threescale handler+instance generated by Kiali

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

500

A Internal is the error message that means something has gone wrong

post/threescale/handlers
/api/threescale/handlers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

deleteThreeScaleHandler

Endpoint to delete an existing threescale handler+instance generated by Kiali

path Parameters
threescaleHandlerName
required
string

The ThreeScaleHandler name.

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

delete/threescale/handlers/{threescaleHandlerName}
/api/threescale/handlers/{threescaleHandlerName}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

patchThreeScaleHandler

Endpoint to update an existing threescale handler generated by Kiali

path Parameters
threescaleHandlerName
required
string

The ThreeScaleHandler name.

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

patch/threescale/handlers/{threescaleHandlerName}
/api/threescale/handlers/{threescaleHandlerName}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

postThreeScaleService

Endpoint to create a new threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

Responses

200

Return Threescale rule definition for a given service

500

A Internal is the error message that means something has gone wrong

post/threescale/namespaces/{namespace}/services
/api/threescale/namespaces/{namespace}/services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "threeScaleHandlerName": "string"
}

getThreeScaleService

Endpoint to get an existing threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Return Threescale rule definition for a given service

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get/threescale/namespaces/{namespace}/services/{service}
/api/threescale/namespaces/{namespace}/services/{service}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "threeScaleHandlerName": "string"
}

deleteThreeScaleService

Endpoint to delete an existing threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

delete/threescale/namespaces/{namespace}/services/{service}
/api/threescale/namespaces/{namespace}/services/{service}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 404,
  • "message": "string"
}

patchThreeScaleService

Endpoint to update an existing threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Return Threescale rule definition for a given service

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

patch/threescale/namespaces/{namespace}/services/{service}
/api/threescale/namespaces/{namespace}/services/{service}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "threeScaleHandlerName": "string"
}